Skip to content

Comments

Produce symbols package and deterministic builds#64

Open
Rob-Hague wants to merge 1 commit intoquestdb:mainfrom
Rob-Hague:nupkg
Open

Produce symbols package and deterministic builds#64
Rob-Hague wants to merge 1 commit intoquestdb:mainfrom
Rob-Hague:nupkg

Conversation

@Rob-Hague
Copy link

@Rob-Hague Rob-Hague commented Feb 7, 2026 •
edited by coderabbitai bot
Loading

These options improve the debugging experience of the library using Source Link (https://learn.microsoft.com/dotnet/standard/library-guidance/sourcelink). When packaging the library, an additional .snpukg "symbol package" file is produced alongside the .nupkg, both of which would be published to nuget.org.

viewing the package in NuGet Package Explorer before:

image

and after:

image

I do not believe azure-binaries-pipeline.yml needs any changes, but I have obviously not tested it.

Summary by CodeRabbit

  • Chores
    • Updated package metadata and licensing information.
    • Added symbol packages for improved debugging support.
    • Included README documentation in the package distribution.
    • Enhanced CI/CD pipeline integration.

@coderabbitai
Copy link

coderabbitai bot commented Feb 7, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

The pull request updates the NuGet package project file to replace deprecated licensing configuration with modern alternatives, adds packaging metadata enhancements including README documentation and symbol packages, and introduces CI build detection for continuous integration environments.

Changes

Cohort / File(s) Summary
NuGet Package Configuration
src/net-questdb-client/net-questdb-client.csproj		 Replaced PackageLicenseUrl with PackageLicenseExpression (Apache-2.0). Added packaging metadata: PackageReadmeFile, EmbedUntrackedSources, IncludeSymbols, and SymbolPackageFormat (snupkg). Included README.md as a package asset. Added TF_BUILD conditional property group for ContinuousIntegrationBuild detection.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Poem

🐰 A package so fine, with metadata new,
License expressed in Apache's true hue,
Symbols embedded, README on display,
CI knows when to build, come what may! ✨

🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately describes the main changes: enabling symbol packages (.snupkg) and deterministic builds through PackageReadmeFile, IncludeSymbols, SymbolPackageFormat, and ContinuousIntegrationBuild properties.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment

No actionable comments were generated in the recent review. 🎉

🧹 Recent nitpick comments
src/net-questdb-client/net-questdb-client.csproj (1)

27-29: Consider also detecting GitHub Actions for deterministic builds.

TF_BUILD only covers Azure DevOps. Since this repository is hosted on GitHub, you may also want to detect GitHub Actions (GITHUB_ACTIONS) to ensure deterministic builds in that environment as well.

Suggested change 
     <PropertyGroup Condition="'$(TF_BUILD)' != ''">
         <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
     </PropertyGroup>
+
+    <PropertyGroup Condition="'$(GITHUB_ACTIONS)' != ''">
+        <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
+    </PropertyGroup>

Or combined into a single group:

-    <PropertyGroup Condition="'$(TF_BUILD)' != ''">
+    <PropertyGroup Condition="'$(TF_BUILD)' != '' Or '$(GITHUB_ACTIONS)' != ''">
         <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
     </PropertyGroup>

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@Rob-Hague